home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / keyb / stfkey40.zip / STUFFKEY.DOC < prev    next >
Text File  |  1992-11-13  |  46KB  |  1,209 lines
  1.                             Documentation
  2.                                  for
  3.                     STUFFIT 3.21 / STUFFKEY 4.00
  4.              ------------------------------------------
  5.           Stuffit Copyright (c) Terje Mathison 1990 - 1992
  6.        Stuffkey Enhancements Copyright (c) Juergen Geist 1992
  7.        ------------------------------------------------------
  8.          Although copyrighted, the described programs are a
  9.                            'labor of love'
  10.                         and completely free!
  11.  
  12.  
  13. Stuffkey.doc Last updated by Juergen Geist 1992 November 16.
  14.      Stuffkey 4.00 has the following enhancements over 3.30
  15.      -    {IfSucc}/{Else}/{Endif} logic using ~{Timeout} on F{Find}
  16.           and P{Prompt} commands.
  17.      -    A {Stop} command.
  18.      -    Improved error message pointers.
  19.  
  20. Stuffkey.doc Last updated by Juergen Geist 1992 October 17.
  21.      Stuffit  3.21 was written by Terje Mathison. 
  22.      Stuffkey 3.30, by Juergen Geist, is Terje's code with the
  23.      following enhancements:
  24.       -   Error messages including error location pointer.
  25.       -   Improved background time handling in Windows, Desqview,
  26.           etc.
  27.       -   Timer resolution down to timer ticks, 1/18 sec.
  28.       -   A time out feature for Prompt and Find commands; the
  29.           first step to adding If/Then/Else login.
  30.       -   A simplified Prompt command, i.e.: p"text".
  31.      It is hoped that Terje will incorporate these mods; to avoid
  32.      confusion until/if he does, Stuffkey will exist. All Stuffkey
  33.      changes are documented here and in the .asm file. The 'zip'
  34.      file should contain both versions of the .asm and .com files.
  35.  
  36. StuffIt.Doc  Last-1 update by Roedy Green 1992 June 21
  37.                          Table of Contents
  38.                           -----------------
  39.           ** To be created soon!
  40. PURPOSE
  41. -------
  42.  
  43. Stuffit 3.21 is a utility that automates the keyboard.  You can
  44. provide a script of keystrokes and Stuffit will automatically
  45. type them into your application programs.  What makes Stuffit
  46. different from other similar keyboard macro programs is:
  47.  
  48.   1. The keyboard remains fully functional the entire time
  49.      for additional manual input or correction.
  50.  
  51.   2. Stuffit works with intractable programs that throw away
  52.      keystrokes, bypass DOS etc.
  53.  
  54.   3. Stuffit watches the screen. It does not just type
  55.      blindly.
  56.  
  57.   4  Stuffkey 4.0 supports if/else/endif logic based on what it
  58.      finds on the screen.
  59.  
  60.   5. Stuffit can handle large scripts, up to 64K.
  61.  
  62.   6. Stuffit lets you generate more possible keystroke
  63.      chords than other similar products.
  64.  
  65.   7. Assembler source code is provided, giving you the
  66.      option of adding new features to the program.
  67. COMMAND LINE PARAMETERS IN A NUTSHELL
  68.  
  69. +0 or +        Delay until the application has used up all the
  70.                keystrokes in the type-ahead buffer.  This is
  71.                useful for applications that throw away keystrokes
  72.                fed to it too quickly.  This is also a handy way
  73.                to flush any pending (uneaten) codes from a
  74.                previous invocation of StuffIt. e.g.: StuffIt +0
  75.                empties StuffIt's internal buffer. Note + all
  76.                by itself defaults to +0.
  77.  
  78. +hh:mm:ss      time delay. (hours and minutes optional) +4 means
  79.                wait 4 seconds (must be 0..59).  +2:4 means wait 2
  80.                minutes and 4 seconds.  +5:: means wait 5 hours.
  81.                Represented internally as {Wait}.  Often you want
  82.                a +5 or so at the start of your script to give the
  83.                program you are stuffing 5 seconds to load and get
  84.                ready for a keystroke.  The timing starts relative
  85.                to when STUFFIT runs, not from when the following
  86.                application requests its first keystroke.
  87.  
  88. +.tt           time delay as above, but in timer ticks, or
  89.                1/18 second resolution. tt can range from 1 to
  90.                18. Note this can't be mixed with hh:mm:ss,
  91.                etc. Useful when you need just a bit of delay
  92.                between keystrokes. +.6 will delay 1/3 second.
  93.                (**-Stuffkey-**)
  94.  
  95. =hh:mm:ss      delay until a specific time of day (24 hour
  96.                format) (hours and minutes optional).  =16:00:00
  97.                means wait till 4 PM.  =00:00:00 means wait till
  98.                midnight.  =0 also means wait till midnight.
  99.                Represented internally as {AtTime}.  Be careful!
  100.                =04:00 would mean 4 minutes after midnight!
  101.  
  102. ~hh:mm:ss      {TimeOut} next function, i.e., {Prompt}, {Find} in
  103.                supplied time. Timer tick format is ok. i.e. ~.15.
  104.                This allows script to continue on a "not found"
  105.                condition. Stuffkey V.4.00 adds the ability to test
  106.                the results of P {Prompt} and F {Find} commands. See
  107.                {IfSucc}, {Else} and {Endif} for details.
  108.                (**-Stuffkey-**).
  109.  
  110. nn             stuff a given character code e.g. 27 for Escape,
  111.                13 for Enter Only ASCII decimal numerics are
  112.                accepted.  See ASCII code chart in your IBM AT
  113.                tech Reference.  You may also use the mnemonics
  114.                e.g. {Esc} for 27.  Note that you may use either
  115.                [] or {} but you must use [{], [}], {[} and {]}
  116.                for the braces and brackets themselves.
  117.  
  118. @nn            stuff an extended code preceded by a null.  Only
  119.                numerics are accepted.  You may use the numeric
  120.                forms or the mnemonics e.g. @68 or {F10}, @73 or
  121.                {PgUp}  See table following for the common codes.
  122.                If you cannot find an mnemonic, you will have to
  123.                use the numeric form.
  124.  
  125. cc:ss          specify both the decimal character and its scan
  126.                code e.g. 43:74 to mean the Plus key on the
  127.                numeric keypad, rather than the ordinary plus key.
  128.                See table following for common pairs.  You may use
  129.                the numeric forms or the mnemonics e.g. 10:28 or
  130.                {^Cr} for Control-Enter.  If you cannot find a
  131.                mnemonic, you will have to use the numeric pair
  132.                form.
  133.  
  134. 'xxxx'         Stuff the characters between the quote marks. The
  135.                string itself may not contain 's.
  136.  
  137. "xxxx"         Stuff the characters between the double quote
  138.                marks.  The string itself may not contain "s.
  139.  
  140. F70,20,5,01,"Please enter your phone number"
  141.                The absolute FIND command.  Wait patiently for
  142.                text to appear at col, row, length, attribute.
  143.                The attribute is optional.  StuffIt searches
  144.                starting at column 70, row 20 for the string
  145.                "Please enter your phone number".  It waits until
  146.                the string appears.  The 5 means allow some slop.
  147.                The string may START anywhere in a window within 5
  148.                characters to the right of the specified starting
  149.                point.  It does not mean the whole string must FIT
  150.                in a window five characters wide.  The slop may
  151.                wrap around from one line to the next.  See the
  152.                notes below on Stuffit's co-ordinate system, where
  153.                1,1 is the upper left corner.  The 01 is a rarely
  154.                used feature.  It means, the match only counts if
  155.                the string is displayed with decimal video
  156.                attribute "01".  If you leave out the 01, leave
  157.                out its comma as well.  Represented internally as
  158.                {Find}.
  159.                (**-Stuffkey-**) Provides the ~ or {TimeOut} feature
  160.                to enable escaping from an "unfound" condition.
  161.  
  162. P10,1,5,01,"Please enter your phone number"
  163.                The relative PROMPT command.  Wait patiently for
  164.                text to appear at relative col, row, length,
  165.                attribute.  The attribute is optional.  Stuffit
  166.                searches for the string "Please enter your phone
  167.                number" st